RESTful Engine Report Configuration Settings
The engine accepts these properties in two different manners:
- Set globally in the application configuration/properties file. These properties will hold true for all reports generated:
- .NET RESTful Engine: web.config
- Java RESTful Engine: WindwardReports.properties
- Set the properties on a per request basis by putting it under the Properties tag in the request body (check here). If you do so, then the properties passed as headers will override the default values we have set, or the values you have set globally in the configuration/properties file.
tip
This page shows properties specific to the RESTful engine. For a list of all properties, see the Java Engine Properties page.
RESTFul Properties
| Property Name | Description |
|---|---|
| license | Global license key used by the Java RESTful Engine when the X-WINDWARD-LICENSE request header is not provided. |
| repository | Optional external repository plugin in the format PATH_TO_JAR!PACKAGE_NAME.CLASS_NAME. If omitted, the default filesystem repository is used. |
| hours-delete-jobs | The number of hours to wait after a document has been generated to delete it from the \App_Data\requests folder. |
| mins-clear-cache | Number of minutes between template cache cleanup runs. |
| requests.path | The path to the folder where the generated documents will be stored. The default is "%CATALINA_HOME%/webapps/App_Data/requests". |
| resource.cache | The path to the folder where the resources will be cached. The default is "%CATALINA_HOME%/webapps/App_Data/cache". |
| lease-timeout-seconds | File lease timeout (seconds) used by the default filesystem repository for active request coordination. |
| lease-interval-seconds | Interval (seconds) used to renew request leases in the default filesystem repository. |
| lease-max-failures | Maximum consecutive lease-renewal failures before lease renewal is canceled for a request. |
| performanceLogging | Enables performance logging when set to on. |
| postProcessor | Optional custom post-processing plugin in the format PATH_TO_JAR!PACKAGE_NAME.CLASS_NAME. |